List of Implicit Objects

This documentation is for an older version of ZK. For the latest one, please click here.

This documentation is for an older version of ZK. For the latest one, please click here.

Object Name	Type	Description
self	Component	The component itself.
spaceOwner	IdSpace	The space owner of this component. It is the same as Owner.
page	Page	The page. It is the same as self.page.
desktop	Desktop	The desktop. It is the same as self.desktop.
execution	Execution	The current execution.
session	Session	The session.
application	WebApp	The Web application.
componentScope	java.util.Map	A map of attributes defined in the component. It is the same as the getAttributes method in the Component interface.
spaceScope	java.util.Map	A map of attributes defined in the ID space containing this component.
pageScope	java.util.Map	A map of attributes defined in the page. It is the same as the getAttributes method in the Page interface.
desktopScope	java.util.Map	A map of attributes defined in the desktop. It is the same as the getAttributes method in the Desktop interface.
sessionScope	java.util.Map	A map of attributes defined in the session. It is the same as the getAttributes method in the Session interface.
applicationScope	java.util.Map	A map of attributes defined in the web application. It is the same as the getAttributes method in the WebApp interface.
requestScope	java.util.Map	A map of attributes defined in the request. It is the same as the getAttributes method in the Execution interface.
param	java.util.Map	A map of attributes passed by the query string. Please refer to section Pass Values to the Included Page for example.
arg	java.util.Map	The arg argument passed to the createComponents method in the Executions class. It is never null. It is the same as self.desktop.execution.arg. Notice that arg is available only when creating the components for the included page (the first argument of createComponents). On the other hand, all events, including onCreate, are processed later. Thus, if you want to access arg in the onCreate's listener, use the getArg method of the org.zkoss.zk.ui.event.CreateEvent class.
each	java.lang.Object	The current item of the collection being iterated, when ZK evaluates an iterative element. An iterative element is an element with the forEach attribute.
forEachStatus	ForEachStatus	The status of an iteration. ZK exposes the information relative to the iteration taking place when evaluating the iterative element.
event	Event or derived	The current event. Available for the event listener only.

Implicit objects provides many useful methods for web application. You can click the hyperlink to see the java doc of each implicit object.